Forgotten files
authorMatthias Clasen <matthiasc@src.gnome.org>
Tue, 30 Dec 2008 20:47:03 +0000 (20:47 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 30 Dec 2008 20:47:03 +0000 (20:47 +0000)
svn path=/trunk/; revision=22014

gtk/gtkfontsel.c
gtk/gtkhscrollbar.c
gtk/gtkmenubar.c

index 394744fd15315887df1234df9bfbf5fdbadf77ea..ef01b05329f8cc31d27d8aec54c2b52123076379 100644 (file)
@@ -1566,13 +1566,11 @@ gtk_font_selection_dialog_init (GtkFontSelectionDialog *fontseldiag)
 
 /**
  * gtk_font_selection_dialog_new:
- * @title: a pointer to a string
+ * @title: the title of the dialog window 
  *
- * The @title is used to set the title of the #GtkFontSelectionDialog
- * returned. This #GtkDialog is specifically catered with widgets for
- * selecting a font from those installed. 
+ * Creates a new #GtkFontSelectionDialog.
  *
- * Return value: a new #GtkFontSelectionDialog.
+ * Return value: a new #GtkFontSelectionDialog
  */
 GtkWidget*
 gtk_font_selection_dialog_new (const gchar *title)
@@ -1695,8 +1693,10 @@ gtk_font_selection_dialog_get_font_name (GtkFontSelectionDialog *fsd)
  * gtk_font_selection_dialog_get_font:
  * @fsd: a #GtkFontSelectionDialog
  *
+ * Gets the currently-selected font.
+ *
  * Return value: the #GdkFont from the #GtkFontSelection for the
- * currently selected font in the dialog.
+ *     currently selected font in the dialog, or %NULL if no font is selected
  *
  * Deprecated: 2.0: Use gtk_font_selection_dialog_get_font_name() instead.
  */
@@ -1711,7 +1711,7 @@ gtk_font_selection_dialog_get_font (GtkFontSelectionDialog *fsd)
 /**
  * gtk_font_selection_dialog_set_font_name:
  * @fsd: a #GtkFontSelectionDialog
- * @fontname: a pointer to a string
+ * @fontname: a font name like "Helvetica 12" or "Times Bold 18"
  *
  * Sets the currently selected font. 
  * 
@@ -1732,12 +1732,11 @@ gtk_font_selection_dialog_set_font_name (GtkFontSelectionDialog *fsd,
  * gtk_font_selection_dialog_get_preview_text:
  * @fsd: a #GtkFontSelectionDialog
  *
- * The text returned is the preview text used to show how the selected
- * font looks.  
- *
- * Return value: pointer to the preview text string. This string
- *     points to internally allocated storage in the widget and must not
- *     be freed, modified or stored. 
+ * Gets the text displayed in the preview area.
+ * 
+ * Return value: the text displayed in the preview area. 
+ *     This string is owned by the widget and should not be 
+ *     modified or freed 
  */
 G_CONST_RETURN gchar*
 gtk_font_selection_dialog_get_preview_text (GtkFontSelectionDialog *fsd)
@@ -1750,9 +1749,9 @@ gtk_font_selection_dialog_get_preview_text (GtkFontSelectionDialog *fsd)
 /**
  * gtk_font_selection_dialog_set_preview_text:
  * @fsd: a #GtkFontSelectionDialog
- * @text: a pointer to a string
+ * @text: the text to display in the preview area
  *
- * The @text is used to show how the selected font looks.
+ * Sets the text displayed in the preview area. 
  */
 void
 gtk_font_selection_dialog_set_preview_text (GtkFontSelectionDialog *fsd,
index a5522fb63b2eda6d28627521bef306d1cca43bc8..64eb5f41308ab18fdc5477d0eed73b0b207bf71a 100644 (file)
@@ -47,6 +47,14 @@ gtk_hscrollbar_init (GtkHScrollbar *hscrollbar)
                                   GTK_ORIENTATION_HORIZONTAL);
 }
 
+/**
+ * gtk_hscrollbar_new:
+ * @adjustment: the #GtkAdjustment to use, or %NULL to create a new adjustment
+ *
+ * Creates a new horizontal scrollbar.
+ *
+ * Returns: the new #GtkHScrollbar
+ */
 GtkWidget *
 gtk_hscrollbar_new (GtkAdjustment *adjustment)
 {
index 2f8560a053c6d90bacaa30114b47a70faf107886..a54e456d1b284290398e19e69fdcde08d120f35e 100644 (file)
@@ -174,7 +174,7 @@ gtk_menu_bar_class_init (GtkMenuBarClass *class)
   /**
    * GtkMenuBar:child-pack-direction:
    *
-   * The pack direction of the menubar. It determines how
+   * The child pack direction of the menubar. It determines how
    * the widgets contained in child menuitems are arranged.
    *
    * Since: 2.8
@@ -828,13 +828,13 @@ gtk_menu_bar_move_current (GtkMenuShell         *menu_shell,
  * gtk_menu_bar_get_pack_direction:
  * @menubar: a #GtkMenuBar
  * 
- * Retrieves the current pack direction of the menubar. See
- * gtk_menu_bar_set_pack_direction().
+ * Retrieves the current pack direction of the menubar. 
+ * See gtk_menu_bar_set_pack_direction().
  *
  * Return value: the pack direction
  *
  * Since: 2.8
- **/
+ */
 GtkPackDirection
 gtk_menu_bar_get_pack_direction (GtkMenuBar *menubar)
 {
@@ -850,13 +850,13 @@ gtk_menu_bar_get_pack_direction (GtkMenuBar *menubar)
 
 /**
  * gtk_menu_bar_set_pack_direction:
- * @menubar: a #GtkMenuBar.
- * @pack_dir: a new #GtkPackDirection.
+ * @menubar: a #GtkMenuBar
+ * @pack_dir: a new #GtkPackDirection
  * 
  * Sets how items should be packed inside a menubar.
  * 
  * Since: 2.8
- **/
+ */
 void
 gtk_menu_bar_set_pack_direction (GtkMenuBar       *menubar,
                                  GtkPackDirection  pack_dir)
@@ -885,13 +885,13 @@ gtk_menu_bar_set_pack_direction (GtkMenuBar       *menubar,
  * gtk_menu_bar_get_child_pack_direction:
  * @menubar: a #GtkMenuBar
  * 
- * Retrieves the current child pack direction of the menubar. See
- * gtk_menu_bar_set_child_pack_direction().
+ * Retrieves the current child pack direction of the menubar.
+ * See gtk_menu_bar_set_child_pack_direction().
  *
  * Return value: the child pack direction
  *
  * Since: 2.8
- **/
+ */
 GtkPackDirection
 gtk_menu_bar_get_child_pack_direction (GtkMenuBar *menubar)
 {
@@ -907,13 +907,13 @@ gtk_menu_bar_get_child_pack_direction (GtkMenuBar *menubar)
 
 /**
  * gtk_menu_bar_set_child_pack_direction:
- * @menubar: a #GtkMenuBar.
- * @child_pack_dir: a new #GtkPackDirection.
+ * @menubar: a #GtkMenuBar
+ * @child_pack_dir: a new #GtkPackDirection
  * 
  * Sets how widgets should be packed inside the children of a menubar.
  * 
  * Since: 2.8
- **/
+ */
 void
 gtk_menu_bar_set_child_pack_direction (GtkMenuBar       *menubar,
                                        GtkPackDirection  child_pack_dir)